home *** CD-ROM | disk | FTP | other *** search
/ 1,000+ Great Games / 1_1000 Games.iso / HERETIC / CONV2HEX.ZIP / CONV2HEX.DOC next >
Encoding:
Text File  |  1995-11-26  |  18.3 KB  |  727 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.     CONV2HEX : doom/heretic to hexen pwad converter
  29.     ───────────────────────────────────────────────────────────────────────
  30.     version 2.00                            (c) 1995, Simply Silly Software
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.                                TABLE OF CONTENTS
  74.                                ─────────────────
  75.  
  76.     Introduction .....................................................  1
  77.       Release Map ....................................................  2
  78.       Legal stuff ....................................................  3
  79.  
  80.     Using CONV2HEX ...................................................  4
  81.       General Format .................................................  4
  82.       Option Switches ................................................  4
  83.          -A Adjusting sector heights automatically ...................  4
  84.          -B Using an alternate behavior lump .........................  4
  85.          -K Allow for key doors ......................................  5
  86.          -M Automatically adding mega weapons ........................  5
  87.          -S Splitting multiple level pwads apart .....................  5
  88.          -1 Start at Map 1 ...........................................  5
  89.       Limitations ....................................................  6
  90.       Problem Reports ................................................  6
  91.  
  92.     About the Conversion Scripts .....................................  7
  93.       Defaults .......................................................  7
  94.       Textures .......................................................  7
  95.       Flats ..........................................................  8
  96.       Things .........................................................  8
  97.       Coming Soon ....................................................  8
  98.  
  99.     Getting Tech Support .............................................  9
  100.     About the Author .................................................  9
  101.     Shameless plug for the Head to Head Gaming Network ...............  9
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.                                   CONV2HEX 2.0
  136.                      doom/doom2/heretic to hexen converter
  137.  
  138.  
  139.     ■ INTRODUCTION ■
  140.  
  141.     CONV2Hex came about   thanks  to  the  H!ZONE  project.   We  had  been
  142.     developing custom heretic levels for a commercial CDROM.  Unfortunately
  143.     , Heretic never  made  it to retail,  and  H!ZONE  was  converted  from
  144.     heretic, to heretic and hexen.
  145.  
  146.     So, we decided to convert 100 or so of the levels we  created  over  to
  147.     Hexen.  Unfortunately... this  proved  to be a very difficult task.   I
  148.     went out and got the only 2 hexen editors  at the time.  Heth (which we
  149.     eventually used for the actual editing) and DEEP.  Now DEEP was
  150.     suppose to be  able to convert pwads... but it's conversion  was  crap.
  151.     Consisting of simply changing the actual file structure.
  152.  
  153.     So, I improvised and created Her2Hex (released about a week ago).  This
  154.     early converter did  a  fairly  good  job  (converting about 60% of the
  155.     linedef types) but was lacking in features.  Over the next few days, as
  156.     I was converting the levels, I kept  adding  features  to  make  my job
  157.     easier.
  158.  
  159.     CONV2Hex is a table driven converter like the one found in D! (my other
  160.     big product).  And hey.. I realized that it would take  about 3 minutes
  161.     to convert the  DOOM/DOOM2  ->  Heretic  scripts  in D! over to the new
  162.     format, and make  them  work  for  hexen  (acutally..  I  converted  to
  163.     heretic, then to hexen.. it's a long story).  So CONV2Hex was born.
  164.  
  165.     Version 2.0 is  very  powerful.  It can now handle around  85%  of  the
  166.     different linedef types  (see  the  section  on  limitations  for  more
  167.     information on what it can and can't  do),  about  50%  of  the  sector
  168.     types, and all  the  different  textures/things.  I've  added  code  to
  169.     automatically add mega  weapons,  adjust  sector heights (the player in
  170.     hexen is taller than the player in heretic)  and even split up multiple
  171.     pwads.  This converter rocks.... as usual.
  172.  
  173.     Now, this converter is designed to be used by PWAD developers  to  help
  174.     them bring their  levels over to hexen.  Although the levels it creates
  175.     are playable immediately, they may  have  no  exits, or areas may still
  176.     not function properly.
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                        1
  196.                         (c) 1995, Simply Silly Software
  197.  
  198.  
  199.  
  200.  
  201.                                   CONV2HEX 2.0
  202.                      doom/doom2/heretic to hexen converter
  203.  
  204.  
  205.     ■ RELEASE MAP ■
  206.  
  207.     version 1.0 (Her2Hex)         Inital release           11/21/95
  208.      - this was the original release, and it was VERY basic.
  209.  
  210.     version 1.2 (Her2Hex)         Internal release         11/23/95
  211.      - Added all the new switches, and nice screens
  212.  
  213.     version 2.0 (Conv2Hex)        Public release
  214.      - This current version
  215.      - Adds DOOM/DOOM2 support
  216.      - Adds support for multiple pwads
  217.      - acutally.. the alternate behavior support isn't in yet
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                        2
  262.                         (c) 1995, Simply Silly Software
  263.  
  264.  
  265.  
  266.  
  267.                                   CONV2HEX 2.0
  268.                      doom/doom2/heretic to hexen converter
  269.  
  270.  
  271.     ■ LEGAL STUFF ■
  272.  
  273.     CONV2Hex is 100% free, but it is not in the public domain.  CONV2Hex is
  274.     a product of Simply Silly Software, and is protected by our copyright.
  275.     We give you  a  license (free of charge) to use CONV2Hex as much as you
  276.     want, give it away, and put it anywhere  online  where users can access
  277.     it free of charge.
  278.  
  279.     You are also  given  permission  to  send this program  to  pay  online
  280.     services such as  Compuserve  and  AOL (even though they charge through
  281.     the teeth) only because I know many  of  you  are  on there and I don't
  282.     want to leave you out.  But a word of advice.. find an ISP.
  283.  
  284.     You MAY NOT however include CONV2HEX on any CDROM compilation,  or sell
  285.     it as part  of  any  type  of package without written consent of Simply
  286.     Silly Software.  Failure to obtain  consent  will violate our copyright
  287.     and subject you  to  legal  action.  In other words..  ASK  FIRST..  We
  288.     almost never say no.
  289.  
  290.     There is no  warrantee,  either express or implied.  You are using this
  291.     program at your own risk.  The authors  have  taken alot of time to try
  292.     and make sure  it  doesn't  thrash  your  pwads, but  hey..  we're  not
  293.     perfect.
  294.  
  295.     The source code the CONV2Hex is available if you really want it.
  296.  
  297.     Hexen is a product of id Software and was developed by Raven Software.
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.                                        3
  328.                         (c) 1995, Simply Silly Software
  329.  
  330.  
  331.  
  332.  
  333.                                   CONV2HEX 2.0
  334.                      doom/doom2/heretic to hexen converter
  335.  
  336.  
  337.     ■ USING CONV2Hex ■
  338.  
  339.     CONV2Hex is a  dos  utility,  but  it  has been tested under DOS, OS/2,
  340.     Windows 3.1 and Win95.  Here is the format for using CONV2Hex.
  341.  
  342.          CONV2HEX <options> [Mode] [source] [target] <report>
  343.  
  344.  
  345.     <options> are optional parameters that  tell  CONV2Hex  to do something
  346.     other than the basic conversion and will be discussed below.  [Mode] is
  347.     a required parameter  that tells CONV2HEX what type  of  PWAD  you  are
  348.     converting from.
  349.  
  350.        Possible values for [Mode]:
  351.  
  352.           d  or doom    : to convert from a DOOM, UDOOM or DOOM 2 pwad
  353.           h  or heretic : to convert from a HERETIC pwad
  354.  
  355.     [Source] is a  required  parameter that points CONV2Hex to the original
  356.     pwad (ie: what you want to convert).   NOTE:  CONV2Hex  makes a copy of
  357.     this pwad before it begins the conversion.  You must have  enough space
  358.     for both the original pwad, the converted pwad, and the working copy.
  359.  
  360.     [Target] is the  name  of  the new pwad (after the conversion).  If you
  361.     are using the -S (split multi-level  pwads:  See  below)  switch,  this
  362.     becomes a template  for  naming  the  different  levels.    If  it's  a
  363.     template, the level  #  is  appended  to  the end of the filename.  For
  364.     example,  if [Target]   was   MYLEVEL   then   the   pwads   would   be
  365.     MYLEVEL01.WAD, etc.
  366.  
  367.     <Report> is an  optional  parameter  that tells CONV2HEX  to  create  a
  368.     problem report textfile while it converts.  This file is important when
  369.     your a developer trying to port a level to hexen.  It will tell you all
  370.     the spots that CONV2HEX couldn't handle.
  371.  
  372.     OPTIONS SWITCHES:
  373.  
  374.     CONV2HEX can take  several options switches to enable advance features.
  375.     They must come  before the [Mode]  entry  in  the  command  line.   All
  376.     options switches begin  with a "-", and you may bundle  more  than  one
  377.     switch after a single "-".  For example:
  378.  
  379.                   "-a -k -m" is the same as "-akm" or "-ak -m"
  380.  
  381.     -A Adjusting sector heights automatically
  382.  
  383.        This switch tell CONV2hex to adjust any sector with a height in
  384.        the range  of  55<x<85 to 85.  This usually fixes that fact that the
  385.        hexen player  is  taller than the  heretic  player.   But  it's  not
  386.        perfect.
  387.  
  388.     -B Using an alternate behavior lump
  389.  
  390.        *** This feature is not yet implemented.
  391.  
  392.  
  393.                                        4
  394.                         (c) 1995, Simply Silly Software
  395.  
  396.  
  397.  
  398.  
  399.                                   CONV2HEX 2.0
  400.                      doom/doom2/heretic to hexen converter
  401.  
  402.  
  403.     -K Allow for key doors
  404.  
  405.        Normally, CONV2Hex  simple  converts  any  key  doors to normal push
  406.        doors.  With the -K switch however, these key doors are kept.
  407.  
  408.        Green keys are converted to the Castle key
  409.        Yellow keys are converted to the Cave key
  410.        Blue keys are converted to the Axe Key
  411.  
  412.     -M Automatically adding mega weapons
  413.  
  414.        If this switch is added, CONV2Hex will attempt to add all 9 mega
  415.        weapon pieces.   It  searches  the  pwad  and  attempts  to  replace
  416.        abundant items with these items.
  417.  
  418.        This options also takes several sub options.  They  must be enclosed
  419.        in "()" and effect when the mega weapons appear.  They are:
  420.  
  421.            1   : Appear on Easiest Skill Levels
  422.            2   : Appear on Normal Skill Level
  423.            3   : Appear on Hardest Skill Levels
  424.            S   : Appear in Single Player Mode
  425.            C   : Appear in CoOp Mode
  426.            D   : Appear in Deathmatch
  427.  
  428.       For example  "-m(123D)" would add the mega weapons so that they would
  429.       appear on all skill levels, but ONLY in deathmatch mode.
  430.  
  431.     -S Splitting multiple level pwads apart
  432.  
  433.       If you are converting a multiple  level  pwad,  you  may wish to have
  434.       CONV2HEX automatically  extract  the  individual   levels   while  it
  435.       converts.
  436.       The -S switch allows you to do that.
  437.  
  438.       When this  switch  is  used,  the [Target] parameter becomes a naming
  439.       template.
  440.  
  441.     -1 Start at Map 1
  442.  
  443.       Normally, CONV2HEX attempts to calculate  the  level  name  using the
  444.       following formula :
  445.  
  446.                    MAPxx = ((Episode-1)*9)+Level
  447.  
  448.       Since Hexen however doesn't always load it's maps  in  order, you can
  449.       tell CONV2HEX to make all maps at MAP01.
  450.  
  451.  
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459.                                        5
  460.                         (c) 1995, Simply Silly Software
  461.  
  462.  
  463.  
  464.  
  465.                                   CONV2HEX 2.0
  466.                      doom/doom2/heretic to hexen converter
  467.  
  468.  
  469.  
  470.     LIMITATIONS:
  471.  
  472.     CONV2HEX is good,  but  it's  not perfect.  The new structure to Hexen,
  473.     and it's scripting language makes  it  very  difficult  to  do an exact
  474.     conversion (like our  DOOM->HERETIC->DOOM2 stuff in  D!).   Here  is  a
  475.     listing of what isn't supported by CONV2HEX (yet).
  476.  
  477.  
  478.     1) Building Stair  linedef types.  Unfortunately this requires the path
  479.        to be marked out.  Originally I was  going to try and come up with a
  480.        method for this, but it's so much easier by hand.
  481.  
  482.     2) End of  level Switches.  These are not directly supported  in  Hexen
  483.        (they require   a  script)  so  that  aren't  support  presently  in
  484.        CONV2HEX.  A special script entry  is  being  worked  on and will be
  485.        added to the default behavior lump.  At that point, CONV2HEX will do
  486.        end of level switches.
  487.  
  488.        End of level walk over linedefs are supported.
  489.  
  490.     3) Sector special: "Wind".  These specials are simply discarded.
  491.  
  492.     4) Sector special:  "Push  Player".   These  specials   are   not   yet
  493.        supported.  When  I  added  support  for  them, the textures got all
  494.        screwed up, so until I figure out what I did wrong, it's a no go.
  495.  
  496.     5) Most Lighting linedef types.  Any  linedef type that requires you to
  497.        fade or brighten to the light in a different sector  isn't supported
  498.        yet (I'm  working  on  the  code).   Snap  to and instant levels are
  499.        supported.
  500.  
  501.     6) For some reason, the resolving of teleporters sometimes breaks down.
  502.        I'm working on it though.
  503.  
  504.     7) Sometimes, raise/lower floors don't work right.
  505.  
  506.     8) The Raise Ceiling/Lower Floor types  don't  work.   Neither does NXP
  507.        Dount.
  508.  
  509.  
  510.     PROBLEM REPORTS:
  511.  
  512.     The best way to convert a pwad is to use the problem  reports.   If you
  513.     add this parameter,  then  CONV2HEX  will  document any areas that were
  514.     unconvertable.  It's then very easy to use these reports to fix-up your
  515.     pwad after the fact.
  516.  
  517.  
  518.  
  519.  
  520.  
  521.  
  522.  
  523.  
  524.  
  525.                                        6
  526.                         (c) 1995, Simply Silly Software
  527.  
  528.  
  529.  
  530.  
  531.                                   CONV2HEX 2.0
  532.                      doom/doom2/heretic to hexen converter
  533.  
  534.  
  535.  
  536.     ■ About the Conversion Scripts ■
  537.  
  538.     There are 2  data  files that go with CONV2HEX: DOOM.CS and HERETIC.CS!
  539.     These are the scripts that are used to convert the pwad.  CONV2HEX uses
  540.     a table driven  conversion  process  (with  some  special  fix-ups  for
  541.     teleports, etc) and these files are used to fill out the  tables.  They
  542.     have 4 different  sections.   If  you need to make a comment, start the
  543.     line with a  "#".   All  of the section  headers  appear  before  their
  544.     sections and are surrounded in "[]" brackets.
  545.  
  546.     DEFAULTS:
  547.  
  548.     The first sections is the defaults section.  The values  here  are used
  549.     if CONV2HEX come across a data value it doesn't understand.  Here is an
  550.     example:
  551.  
  552.            [DEFAULTS]
  553.  
  554.            defaultTexture=CASTLE01
  555.            defaultFlat=F_009
  556.            defaultThing=111
  557.  
  558.  
  559.     TEXTURES:
  560.  
  561.     The next section  is  the  Textures section.  CONV2HEX uses the
  562.     data here to convert the wall textures.  It uses the format
  563.  
  564.                        old_texture = new_texture
  565.  
  566.     You can modify these entries (or add new ones) to customize the
  567.     conversion or to have CONV2HEX  be  able  to  handle any custom
  568.     textures you may already have in there.
  569.  
  570.     Here is an example
  571.  
  572.            [TEXTURES]
  573.  
  574.                   -=-
  575.            BADPATCH=CASTLE01
  576.            BANNER1=FOREST05
  577.            BANNER2=CASTLE01
  578.            BANNER3=CASTLE01
  579.            BANNER4=CASTLE01
  580.  
  581.  
  582.  
  583.  
  584.  
  585.  
  586.  
  587.  
  588.  
  589.  
  590.  
  591.                                        7
  592.                         (c) 1995, Simply Silly Software
  593.  
  594.  
  595.  
  596.  
  597.                                   CONV2HEX 2.0
  598.                      doom/doom2/heretic to hexen converter
  599.  
  600.  
  601.  
  602.     FLATS:
  603.  
  604.     The next section  holds  the  conversion  information  for  the
  605.     floor/ceiling flats.  It's  just   like  the  TEXTURES  section
  606.     above.  For example:
  607.  
  608.            [FLATS]
  609.  
  610.            FLOOR00=F_022
  611.            FLOOR01=F_038
  612.            FLOOR03=F_018
  613.            FLOOR04=F_020
  614.            FLOOR05=F_019
  615.            FLOOR06=F_046
  616.  
  617.  
  618.     THINGS:
  619.  
  620.     The last section  currently  available  is the THINGS  section.
  621.     This holds the conversion table for all the different things in
  622.     the game.
  623.  
  624.     It also uses  the  old_thing=new_thing  format  and can be seen
  625.     below.
  626.  
  627.            [THINGS]
  628.  
  629.               1=1
  630.               2=2
  631.               3=3
  632.               4=4
  633.              11=11
  634.              14=14
  635.              74=140
  636.  
  637.  
  638.     A WORD ON SPACING:
  639.  
  640.     Please try to space out the scripts  as the originals are.  I'm
  641.     not sure if it's important.. by why screw with it.
  642.  
  643.     COMING SOON:
  644.  
  645.     I'm working on adding 2 new sections to the conversion scripts.
  646.     These sections will define how Linedef types,  and  how  sector
  647.     types are converted.  It's not in yet, but I'm working on it.
  648.  
  649.  
  650.  
  651.  
  652.  
  653.  
  654.  
  655.  
  656.  
  657.                                        8
  658.                         (c) 1995, Simply Silly Software
  659.  
  660.  
  661.  
  662.  
  663.                                   CONV2HEX 2.0
  664.                      doom/doom2/heretic to hexen converter
  665.  
  666.  
  667.  
  668.     ■ Getting Tech Support ■
  669.  
  670.     Simple.. there is  no.  It's up to you to figure out how to use
  671.     this utility.  I've tried to make it as easy a possible.
  672.  
  673.     You can of course try to contact  me  at  Joew@netzone.com (for
  674.     the next 2  weeks)  or  Joe@SillySoft.com  (after   that)  with
  675.     problems, suggestions, or  bug reports.  I just can't guarantee
  676.     I'll get back to you.
  677.  
  678.  
  679.     ■ About the Author ■
  680.  
  681.     Simply Silly Software has been  creating  add-ons and utilities
  682.     for DOOM since it came out.  We have built the best  front-ends
  683.     (Doom/Master and D!),  editors (IDE) and founded the pwad group
  684.     -VS-.
  685.  
  686.     We are also  the creators of the  very  popular  D!ZONE  cdroms
  687.     published by WizardWorks.
  688.  
  689.     ■ Shameless Plug ■
  690.  
  691.     Ut-oh.. tired of pay way to much for choppy... crappy  games on
  692.     dwango...  Come check  out the new Head to Head Gaming network.
  693.     We are small, but we are growing.   Grab out ultra-slick client
  694.     on FTP.CDROM.COM or any find site/bbs.  Or call  one of the H2H
  695.     Systems and download it there (we HAVE
  696.     a file area).
  697.  
  698.                     Battle Station #1:  619-426-0073
  699.                     Battle Station #2:  714-572-3666
  700.                     Battle Station #3:  602-303-9816
  701.  
  702.  
  703.  
  704.  
  705.  
  706.  
  707.  
  708.  
  709.  
  710.  
  711.  
  712.  
  713.  
  714.  
  715.  
  716.  
  717.  
  718.  
  719.  
  720.  
  721.  
  722.  
  723.                                        9
  724.                         (c) 1995, Simply Silly Software
  725.  
  726.  
  727.